<meta charset="utf-8">
(#) Instant App Issues

!!! WARNING: Instant App Issues
   This is a warning.

Id
:   `InstantApps`
Summary
:   Instant App Issues
Severity
:   Warning
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   3.0.0 (October 2017)
Affects
:   Kotlin and Java files and manifest files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/InstantAppDetector.java)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/InstantAppDetectorTest.java)

This issue flags code that will not work correctly in Instant Apps.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/main/AndroidManifest.xml:10:Warning: Instant Apps are not allowed to
export services, receivers, and providers [InstantApps]
    &lt;service android:name=".WearMessageListenerService"&gt;
    ^
src/main/AndroidManifest.xml:15:Warning: Instant Apps are not allowed to
export services, receivers, and providers [InstantApps]
    &lt;provider android:name=".TestService" /&gt;
    ----------------------------------------
src/main/AndroidManifest.xml:16:Warning: Instant Apps are not allowed to
export services, receivers, and providers [InstantApps]
    &lt;receiver android:name=".DeviceAdminTestReceiver"
    ^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/main/AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="test.pkg" &gt;
    &lt;uses-sdk android:targetSdkVersion="23" /&gt;

    &lt;application
        android:label="@string/app_name"
        android:allowBackup="false"
        android:theme="@style/AppTheme" &gt;
        &lt;service android:name=".WearMessageListenerService"&gt;
              &lt;intent-filter&gt;
                  &lt;action android:name="com.google.android.gms.wearable.BIND_LISTENER" /&gt;
              &lt;/intent-filter&gt;
        &lt;/service&gt;
        &lt;provider android:name=".TestService" /&gt;
        &lt;receiver android:name=".DeviceAdminTestReceiver"
                  android:label="@string/app_name"
                  android:description="@string/app_name"
                  android:permission="android.permission.BIND_DEVICE_ADMIN"&gt;
            &lt;meta-data android:name="android.app.device_admin"
                       android:resource="@xml/device_admin"/&gt;
            &lt;intent-filter&gt;
                &lt;action android:name="android.app.action.DEVICE_ADMIN_ENABLED"/&gt;
            &lt;/intent-filter&gt;
        &lt;/receiver&gt;

    &lt;/application&gt;

&lt;/manifest&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/InstantAppDetectorTest.java)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `InstantAppDetector.testForbiddenManifestTags`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Adding the suppression attribute `tools:ignore="InstantApps"` on the
  problematic XML element (or one of its enclosing elements). You may
  also need to add the following namespace declaration on the root
  element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;manifest xmlns:tools="http://schemas.android.com/tools"&gt;
      ...
      &lt;provider tools:ignore="InstantApps" .../&gt;
    ...
  &lt;/manifest&gt;
  ```

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("InstantApps")
  fun method() {
     notify(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("InstantApps")
  void method() {
     notify(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection InstantApps
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="InstantApps" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'InstantApps'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore InstantApps ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>